home *** CD-ROM | disk | FTP | other *** search
/ Skunkware 5 / Skunkware 5.iso / man / cat.6 / dgn_comp.6 < prev    next >
Text File  |  1995-07-25  |  14KB  |  265 lines
  1.  
  2.  
  3.  
  4.      DDDDGGGGNNNN____CCCCOOOOMMMMPPPP((((6666))))        UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((1111 MMMMaaaayyyy 1111999999992222))))         DDDDGGGGNNNN____CCCCOOOOMMMMPPPP((((6666))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           dgn_comp - NetHack dungeon compiler
  10.  
  11.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.           ddddggggnnnn____ccccoooommmmpppp [ _f_i_l_e ]
  13.  
  14.           If no arguments are given, it reads standard input.
  15.  
  16.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  17.           _D_g_n__c_o_m_p is a dungeon compiler for NetHack version 3.1 and
  18.           higher.  It takes a description file as an argument and
  19.           produces a dungeon "script" that is to be loaded by NetHack
  20.           at runtime.
  21.  
  22.           The purpose of this tool is to provide NetHack
  23.           administrators and implementors with a convenient way to
  24.           create a custom dungeon for the game, without having to
  25.           recompile the entire world.
  26.  
  27.      GGGGRRRRAAAAMMMMMMMMAAAARRRR
  28.           DUNGEON: nnnnaaaammmmeeee bbbboooonnnneeeessssmmmmaaaarrrrkkkkeeeerrrr ( bbbbaaaasssseeee , rrrraaaannnndddd ) [ %%%%aaaaggggeeee ]
  29.  
  30.           where nnnnaaaammmmeeee is the dungeon name, bbbboooonnnneeeessssmmmmaaaarrrrkkkkeeeerrrr is a letter for
  31.           marking bones files, ( bbbbaaaasssseeee , rrrraaaannnndddd ) is the number of
  32.           levels, and %%%%aaaaggggeeee is its percentage chance of being generated
  33.           (if absent, 100% chance).
  34.  
  35.           DESCRIPTION: ttttaaaagggg
  36.  
  37.           where ttttaaaagggg is currently one of HHHHEEEELLLLLLLLIIIISSSSHHHH, MMMMAAAAZZZZEEEELLLLIIIIKKKKEEEE, or
  38.           RRRROOOOGGGGUUUUEEEELLLLIIIIKKKKEEEE.
  39.  
  40.           ALIGNMENT | LEVALIGN: [ llllaaaawwwwffffuuuullll | nnnneeeeuuuuttttrrrraaaallll | cccchhhhaaaaoooottttiiiicccc |
  41.           uuuunnnnaaaalllliiiiggggnnnneeeedddd ]
  42.  
  43.           gives the alignment of the dungeon/level (default is
  44.           unaligned).
  45.  
  46.           ENTRY: lllleeeevvvveeeellll
  47.  
  48.           the dungeon entry point.  The dungeon connection attaches at
  49.           this level of the given dungeon.  If the value of lllleeeevvvveeeellll is
  50.           negative, the entry level is calculated from the bottom of
  51.           the dungeon, with -1 being the last level.  If this line is
  52.           not present in a dungeon description, the entry level
  53.           defaults to 1.
  54.  
  55.           PROTOFILE: nnnnaaaammmmeeee
  56.  
  57.           the prototypical name for dungeon level files in this
  58.           dungeon.  For example, the PROTOFILE name for the dungeon
  59.           _V_l_a_d'_s _T_o_w_e_r is _t_o_w_e_r.
  60.  
  61.  
  62.  
  63.      Page 1                                           (printed 7/7/95)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      DDDDGGGGNNNN____CCCCOOOOMMMMPPPP((((6666))))        UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((1111 MMMMaaaayyyy 1111999999992222))))         DDDDGGGGNNNN____CCCCOOOOMMMMPPPP((((6666))))
  71.  
  72.  
  73.  
  74.           LEVEL: nnnnaaaammmmeeee bbbboooonnnneeeessssmmmmaaaarrrrkkkkeeeerrrr @ ( bbbbaaaasssseeee , rrrraaaannnndddd ) [ %%%%aaaaggggeeee ]
  75.  
  76.           where nnnnaaaammmmeeee is the level name, bbbboooonnnneeeessssmmmmaaaarrrrkkkkeeeerrrr is a letter for
  77.           marking bones files, ( bbbbaaaasssseeee , rrrraaaannnndddd ) is the location and
  78.           %%%%aaaaggggeeee is the generation percentage, as above.
  79.  
  80.           RNDLEVEL: nnnnaaaammmmeeee bbbboooonnnneeeessssmmmmaaaarrrrkkkkeeeerrrr @ ( bbbbaaaasssseeee , rrrraaaannnndddd ) [ %%%%aaaaggggeeee ]
  81.           rrrrnnnnddddlllleeeevvvvssss
  82.  
  83.           where nnnnaaaammmmeeee is the level name, bbbboooonnnneeeessssmmmmaaaarrrrkkkkeeeerrrr is a letter for
  84.           marking bones files, ( bbbbaaaasssseeee , rrrraaaannnndddd ) is the location, %%%%aaaaggggeeee
  85.           is the generation percentage, as above, and rrrrnnnnddddlllleeeevvvvssss is the
  86.           number of similar levels available to choose from.
  87.  
  88.           CHAINLEVEL: nnnnaaaammmmeeee bbbboooonnnneeeessssmmmmaaaarrrrkkkkeeeerrrr pppprrrreeeevvvv____nnnnaaaammmmeeee + ( bbbbaaaasssseeee , rrrraaaannnndddd ) [
  89.           %%%%aaaaggggeeee ]
  90.  
  91.           where nnnnaaaammmmeeee is the level name, bbbboooonnnneeeessssmmmmaaaarrrrkkkkeeeerrrr is a letter for
  92.           marking bones files, pppprrrreeeevvvv____nnnnaaaammmmeeee is the name of a level
  93.           defined previously, ( bbbbaaaasssseeee , rrrraaaannnndddd ) is the _o_f_f_s_e_t from the
  94.           level being chained from, and %%%%aaaaggggeeee is the generation
  95.           percentage.
  96.  
  97.           RNDCHAINLEVEL: nnnnaaaammmmeeee bbbboooonnnneeeessssmmmmaaaarrrrkkkkeeeerrrr pppprrrreeeevvvv____nnnnaaaammmmeeee + ( bbbbaaaasssseeee , rrrraaaannnndddd )
  98.           [ %%%%aaaaggggeeee ] rrrrnnnnddddlllleeeevvvvssss
  99.  
  100.           where nnnnaaaammmmeeee is the level name, bbbboooonnnneeeessssmmmmaaaarrrrkkkkeeeerrrr is a letter for
  101.           marking bones files, pppprrrreeeevvvv____nnnnaaaammmmeeee is the name of a level
  102.           defined previously, ( bbbbaaaasssseeee , rrrraaaannnndddd ) is the _o_f_f_s_e_t from the
  103.           level being chained from, %%%%aaaaggggeeee is the generation percentage,
  104.           and rrrrnnnnddddlllleeeevvvvssss is the number of similar levels available to
  105.           choose from.
  106.  
  107.           BRANCH: nnnnaaaammmmeeee @ ( bbbbaaaasssseeee , rrrraaaannnndddd ) [ ssssttttaaaaiiiirrrr | nnnnoooo____uuuupppp | nnnnoooo____ddddoooowwwwnnnn |
  108.           ppppoooorrrrttttaaaallll ] [ uuuupppp | ddddoooowwwwnnnn ]
  109.  
  110.           where nnnnaaaammmmeeee is the name of the dungeon to branch to, and (
  111.           bbbbaaaasssseeee , rrrraaaannnndddd ) is the location of the branch.  The last two
  112.           optional arguments are the branch type and branch direction.
  113.           The type of a branch can be a two-way stair connection, a
  114.           one-way stair connection, or a magic portal.  A one-way
  115.           stair is described by the types nnnnoooo____uuuupppp and nnnnoooo____ddddoooowwwwnnnn which
  116.           specify which stair direction is missing.  The default
  117.           branch type is ssssttttaaaaiiiirrrr.  The direction for a stair can be
  118.           either up or down; direction is not applicable to portals.
  119.           The default direction is ddddoooowwwwnnnn.
  120.  
  121.           CHAINBRANCH: nnnnaaaammmmeeee pppprrrreeeevvvv____nnnnaaaammmmeeee + ( bbbbaaaasssseeee , rrrraaaannnndddd ) [ ssssttttaaaaiiiirrrr |
  122.           nnnnoooo____uuuupppp | nnnnoooo____ddddoooowwwwnnnn | ppppoooorrrrttttaaaallll ] [ uuuupppp | ddddoooowwwwnnnn ]
  123.  
  124.           where nnnnaaaammmmeeee is the name of the dungeon to branch to,
  125.           pppprrrreeeevvvv____nnnnaaaammmmeeee is the name of a previously defined lllleeeevvvveeeellll and (
  126.  
  127.  
  128.  
  129.      Page 2                                           (printed 7/7/95)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      DDDDGGGGNNNN____CCCCOOOOMMMMPPPP((((6666))))        UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((1111 MMMMaaaayyyy 1111999999992222))))         DDDDGGGGNNNN____CCCCOOOOMMMMPPPP((((6666))))
  137.  
  138.  
  139.  
  140.           bbbbaaaasssseeee , rrrraaaannnndddd ) is the _o_f_f_s_e_t from the level being chained
  141.           from.  The optional branch type and direction are the same
  142.           as described above.
  143.  
  144.      GGGGEEEENNNNEEEERRRRIIIICCCC RRRRUUUULLLLEEEESSSS
  145.           Each dungeon must have a unique bbbboooonnnneeeessssmmmmaaaarrrrkkkkeeeerrrr ,,,, and each
  146.           special level must have a bbbboooonnnneeeessssmmmmaaaarrrrkkkkeeeerrrr unique within its
  147.           dungeon (letters may be reused in different dungeons).  If
  148.           the bbbboooonnnneeeessssmmmmaaaarrrrkkkkeeeerrrr has the special value "none", no bones files
  149.           will be created for that level or dungeon.
  150.  
  151.           The value bbbbaaaasssseeee may be in the range of 1 to MMMMAAAAXXXXLLLLEEEEVVVVEEEELLLL (as
  152.           defined in _g_l_o_b_a_l._h ).
  153.  
  154.           The value rrrraaaannnndddd may be in the range of -1 to MMMMAAAAXXXXLLLLEEEEVVVVEEEELLLL.
  155.  
  156.           If rrrraaaannnndddd is -1 it will be replaced with the value
  157.           (num_dunlevs(dungeon) - base) during the load process (ie.
  158.           from here to the end of the dungeon).
  159.  
  160.           If rrrraaaannnndddd is 0 the level is located absolutely at bbbbaaaasssseeee.
  161.  
  162.           Branches don't have a probability.  Dungeons do.  If a
  163.           dungeon fails to be generated during load, all its levels
  164.           and branches are skipped.
  165.  
  166.           No level or branch may be chained from a level with a
  167.           percentage generation probability.  This is to prevent non-
  168.           resolution during the load.  In addition, no branch may be
  169.           made from a dungeon with a percentage generation probability
  170.           for the same reason.
  171.  
  172.           As a general rule using the dungeon compiler:
  173.  
  174.           If a dungeon has a pppprrrroooottttooooffffiiiilllleeee name associated with it (_e_g.
  175.           ttttoooowwwweeeerrrr) that file will be used.
  176.  
  177.           If a special level is present, it will override the above
  178.           rule and the appropriate file will be loaded.
  179.  
  180.           If neither of the above are present, the standard generator
  181.           will take over and make a "normal" level.
  182.  
  183.           A level alignment, if present, will override the alignment
  184.           of the dungeon that it exists within.
  185.  
  186.      EEEEXXXXAAAAMMMMPPPPLLLLEEEE
  187.           Here is the current syntax of the dungeon compiler's
  188.           "language":
  189.  
  190.  
  191.           #
  192.  
  193.  
  194.  
  195.      Page 3                                           (printed 7/7/95)
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.      DDDDGGGGNNNN____CCCCOOOOMMMMPPPP((((6666))))        UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((1111 MMMMaaaayyyy 1111999999992222))))         DDDDGGGGNNNN____CCCCOOOOMMMMPPPP((((6666))))
  203.  
  204.  
  205.  
  206.           #       The dungeon description file for the "standard" original
  207.           #       3.0 NetHack.
  208.           #
  209.           DUNGEON:        "The Dungeons of Doom" "D" (25, 5)
  210.           LEVEL:          "rogue" "none" @ (15, 4)
  211.           LEVEL:          "oracle" "none" @ (5, 7)
  212.           LEVEL:          "bigroom" "B" @ (12, 3) 15
  213.           LEVEL:          "medusa" "none" @ (20, 5)
  214.           CHAINLEVEL:     "castle" "medusa" + (1, 4)
  215.           CHAINBRANCH:    "Hell" "castle" + (0, 0) no_down
  216.           BRANCH:         "The Astral Plane" @ (1, 0) no_down up
  217.  
  218.           DUNGEON:        "Hell" "H" (25, 5)
  219.           DESCRIPTION:    mazelike
  220.           DESCRIPTION:    hellish
  221.           BRANCH:         "Vlad's Tower" @ (13, 5) up
  222.           LEVEL:          "wizard" "none" @ (15, 10)
  223.           LEVEL:          "fakewiz" "A" @ (5, 5)
  224.           LEVEL:          "fakewiz" "B" @ (10, 5)
  225.           LEVEL:          "fakewiz" "C" @ (15, 5)
  226.           LEVEL:          "fakewiz" "D" @ (20, 5)
  227.           LEVEL:          "fakewiz" "E" @ (25, 5)
  228.  
  229.           DUNGEON:        "Vlad's Tower" "T" (3, 0)
  230.           PROTOFILE:      "tower"
  231.           DESCRIPTION:    mazelike
  232.           ENTRY:          -1
  233.  
  234.           DUNGEON:        "The Astral Plane" "A" (1, 0)
  235.           DESCRIPTION:    mazelike
  236.           PROTOFILE:      "endgame"
  237.  
  238.           _N_O_T_E_S:
  239.           Lines beginning with '#' are considered comments.
  240.           A special level must be explicitly aligned.  The alignment
  241.           of the dungeon it is in only applies to non-special levels
  242.           within that dungeon.
  243.  
  244.      AAAAUUUUTTTTHHHHOOOORRRR
  245.           M. Stephenson (from the level compiler by Jean-Christophe
  246.           Collet).
  247.  
  248.      SSSSEEEEEEEE AAAALLLLSSSSOOOO
  249.           lev_comp(6), nethack(6)
  250.  
  251.      BBBBUUUUGGGGSSSS
  252.           Probably infinite.
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.      Page 4                                           (printed 7/7/95)
  262.  
  263.  
  264.  
  265.